楽天ペイv2随時決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranRakutenpay 取引登録

これ以降の利用承諾で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
JobCd	jobCd	必須処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount	amount	必須半角数字7桁利用金額
Tax	tax	半角数字7桁税送料税送料を指定した場合は、利用金額＋税送料が決済金額となります。

URL

/payment/EntryTranRakutenpay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "AUTH",
  "amount": "1000",
  "tax": "100"
}

URL

/payment/EntryTranRakutenpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000&Tax=100

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "467d50a6bc03dabe1713f8d49042bd96",
  "accessPass": "bfa37e690fdcc229b2c5185228ace517"
}

レスポンスパラメータ：正常系

AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranRakutenpay 決済実行

決済処理を行い結果を返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
Description	description	全半角300桁楽天説明文設定内容はこちら
SubscriptionType	subscriptionType	必須サブスクリプションタイプ SETTLEMENT：随時決済を実行
SettlementSubscriptionID	settlementSubscriptionID	必須半角英数記号15桁決済用サブスクリプションID 「利用承諾のみ」「都度決済+利用承諾」で発行されたサブスクリプションIDを設定してください。

URL

/payment/ExecTranRakutenpay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "subscriptionType": "SETTLEMENT",
  "settlementSubscriptionID": "sub_XXXXXXXXXXX"
}

URL

/payment/ExecTranRakutenpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&SubscriptionType=SETTLEMENT&SettlementSubscriptionID=sub_XXXXXXXXXXX

レスポンス

正常

ShopID	shopID	必須半角英数13桁ショップID
OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態処理成功時・AUTH ・CAPTURE 処理失敗時・PAYFAIL
TranDate	tranDate	必須半角英数14桁固定処理日時 yyyyMMddHHmmss書式
RakutenChargeID	rakutenChargeID	必須半角英数記号32桁楽天チャージID 決済成功時のみ値を設定します。
CheckString	checkString	必須改ざんチェック文字列 OrderID,AccessID,ShopID,ShopPass,RakutenChargeID,Statusを連結しSHA256のハッシュ値を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "shopID": "tshop11223344",
  "orderID": "ORDER0000001",
  "status": "AUTH",
  "tranDate": "20210415110000"
  "rakutenChargeID": "ch_67XXXXXXX8M",
  "checkString": "123fe4567ce89e8a0fc12e34567e14bda475561c469c99dc1dc3c4fec9089438"
}

レスポンスパラメータ：正常系

ShopID=tshop11223344&OrderID=ORDER0000001&Status=AUTH&TranDate=20210415110000&RakutenChargeID=ch_67XXXXXXX8M&CheckString=123fe4567ce89e8a0fc12e34567e14bda475561c469c99dc1dc3c4fec9089438

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RakutenpaySales 実売上

仮売上の決済に対して実売上を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字7桁利用金額取引の利用金額と一致しない場合エラーとなります。
Tax	tax	半角数字7桁税送料取引の税送料と一致しない場合エラーとなります。

URL

/payment/RakutenpaySales.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "467d50a6bc03dabe1713f8d49042bd96",
    "accessPass": "bfa37e690fdcc229b2c5185228ace517",
    "orderID": "ORDER0000001",
    "amount": "1000",
    "tax": "0"
}

URL

/payment/RakutenpaySales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517&OrderID=ORDER0000001&Amount=1000&Tax=0

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態売上確定成功時・SALES：実売上売上確定失敗時・AUTH：仮売上
Amount	amount	必須半角数字7桁利用金額
Tax	tax	必須半角数字7桁税送料

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "1000",
    "tax": "100"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=100

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RakutenpayCancelReturn キャンセル・返品

決済が完了した取引に対して決済内容のキャンセル・返品を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
CancelAmount	cancelAmount	必須半角数字7桁キャンセル金額取引の利用金額と一致しない場合エラーとなります。
CancelTax	cancelTax	半角数字7桁キャンセル税送料取引の税送料と一致しない場合エラーとなります。

URL

/payment/RakutenpayCancelReturn.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "467d50a6bc03dabe1713f8d49042bd96",
    "accessPass": "bfa37e690fdcc229b2c5185228ace517",
    "orderID": "ORDER0000001",
    "cancelAmount": "1000",
    "cancelTax": "0"
}

URL

/payment/RakutenpayCancelReturn.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517&OrderID=ORDER0000001&CancelAmount=1000&CancelTax=0

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
Status	status	必須現状態キャンセル・返品成功時 CANCEL：キャンセル RETURN：返品
Amount	amount	必須半角数字7桁利用金額キャンセル・返品成功時は0を返却します。
Tax	tax	必須半角数字7桁税送料キャンセル・返品成功時は0を返却します。
CancelAmount	cancelAmount	必須半角数字7桁キャンセル金額リクエストしたキャンセル・返品金額を返却します。
CancelTax	cancelTax	必須半角数字7桁キャンセル税送料リクエストしたキャンセル・返品税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "CANCEL",
    "amount": "0",
    "tax": "0",
    "cancelAmount": "1000",
    "cancelTax": "10"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=10

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RakutenpayChange 金額変更

仮売上・即時売上・実売上の取引に対して金額変更を行います。仮売上の取引は仮売上時と同額を指定することで、仮売上有効期限の延長（再オーソリ）を行うことができます。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字7桁変更後金額変更後金額 + 変更後税送料が処理金額となります。
Tax	tax	半角数字7桁変更後税送料変更後金額 + 変更後税送料が処理金額となります。

URL

/payment/RakutenpayChange.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "467d50a6bc03dabe1713f8d49042bd96",
    "accessPass": "bfa37e690fdcc229b2c5185228ace517",
    "orderID": "ORDER0000001",
    "amount": "1100",
    "tax": "0"
}

URL

/payment/RakutenpayChange.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517&OrderID=ORDER0000001&Amount=1100&Tax=0

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態金額変更処理前のステータスが返却されます。
Amount	amount	必須半角数字7桁変更後利用金額金額変更した利用金額を返却します。
Tax	tax	必須半角数字7桁変更後税送料金額変更した税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "1000",
    "tax": "100"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=100

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RakutenpayAcceptUpdate 利用承諾変更

指定したサブスクリプションIDの内容を変更することが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
SubscriptionName	subscriptionName	必須全半角200桁サブスクリプション名称変更後のサブスクリプション名称を指定してください。

URL

/payment/RakutenpayAcceptUpdate.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "467d50a6bc03dabe1713f8d49042bd96",
  "accessPass": "bfa37e690fdcc229b2c5185228ace517",
  "orderID": "ORDER0000001",
  "subscriptionName": "テスト商品名"
}

URL

/payment/RakutenpayAcceptUpdate.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517&OrderID=ORDER0000001&SubscriptionName=テスト商品名

レスポンス

正常

OrderID		orderID		必須半角英数記号27桁オーダーID
Status		status		必須現状態

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "REGISTER"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=REGISTER

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeRakutenpay/SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
PayType	payType	半角数字2桁決済方法 SearchTradeMultiをご利用の際は「50」を指定してください。 SearchTradeRakutenpayをご利用の際は設定不要です。

URL

/payment/SearchTradeRakutenpay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001"
}

URL：SearchTradeRakutenpayの場合

/payment/SearchTradeRakutenpay.idPass

URL：SearchTradeMultiの場合

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=50

レスポンス

正常

Status	status	必須現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証処理中 PAYFAIL：決済失敗 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 CANCEL：キャンセル RETURN：返品 EXPIRED：期限切れ
ProcessDate	processDate	必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd	jobCd	必須処理区分 AUTH：仮売上 CAPTURE：即時売上 SALES：実売上 CANCEL：キャンセル RETURN：返品 CHANGE：金額変更 ACCCEPTUPDATE：利用承諾変更
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
Amount	amount	必須半角数字7桁利用金額
Tax	tax	必須半角数字7桁税送料
ClientField1	clientField1	必須全半角100バイト加盟店自由項目1
ClientField2	clientField2	必須全半角100バイト加盟店自由項目2
ClientField3	clientField3	必須全半角100バイト加盟店自由項目3
PayType	payType	必須半角数字2桁決済方法 50：楽天ペイ（オンライン決済）V2
RakutenChargeID	rakutenChargeID	半角英数記号32桁楽天チャージID
ReauthLimitDate	reauthLimitDate	半角数字14桁固定仮売上有効期限延長期限 yyyyMMddHHmmss書式
SalesLimitDate	salesLimitDate	半角数字14桁固定実売上期限 yyyyMMddHHmmss書式
ChangeLimitDate	changeLimitDate	半角数字14桁固定金額変更期限 yyyyMMddHHmmss書式
CancelLimitDate	cancelLimitDate	半角数字14桁固定キャンセル期限 yyyyMMddHHmmss書式
RakutenPoint	rakutenPoint	半角数字7桁楽天ペイで使用されたポイント
RakutenSubscriptionType	rakutenSubscriptionType	半角英字10桁サブスクリプションタイプ SETTLEMENT：随時決済
RakutenSubscriptionID	rakutenSubscriptionID	半角英数記号15桁サブスクリプションID 随時決済の場合は値を返却しません。
RakutenSettlementSubscriptionID	rakutenSettlementSubscriptionID	半角英数記号15桁随時決済時に用いたサブスクリプションID 随時決済実行時に指定された決済用サブスクリプションIDを返却します。
RakutenSubscriptionCurrentStatus	rakutenSubscriptionCurrentStatus	サブスクリプション現状態随時決済の場合は値を返却しません。
RakutenSubscriptionStartDate	rakutenSubscriptionStartDate	半角数字14桁固定利用承諾日付随時決済の場合は値を返却しません。
RakutenSubscriptionAmount	rakutenSubscriptionAmount	半角数字7桁利用承諾金額随時決済の場合は値を返却しません。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "status": "CAPTURE",
  "processDate": "20210308125035",
  "jobCd": "CAPTURE",
  "accessID": "2bb0da27c4cf3e95b810509bb4541397",
  "accessPass": "fb8f3d9c7408e8eb47448010d356cd58",
  "amount": "1000",
  "tax": "100",
  "clientField1": "",
  "clientField2": "",
  "clientField3": "",
  "payType": "50",
  "rakutenChargeID": "ch_67XXXXXXX8M",
  "reauthLimitDate": "",
  "salesLimitDate": "",
  "changeLimitDate": "20210308125035",
  "cancelLimitDate": "20210308125035",
  "rakutenPoint": "",
  "rakutenSubscriptionType": "SETTLEMENT",
  "rakutenSubscriptionID": "",
  "rakutenSettlementSubscriptionID": "sub_XXXXXXXXXXX",
  "rakutenSubscriptionCurrentStatus": "",
  "rakutenSubscriptionStartDate": "",
  "rakutenSubscriptionAmount": ""
}

レスポンスパラメータ：正常系

Status=CAPTURE&ProcessDate=20210308125035&JobCd=CAPTURE&AccessID=2bb0da27c4cf3e95b810509bb4541397&AccessPass=fb8f3d9c7408e8eb47448010d356cd58&Amount=1000&Tax=100&ClientField1=&ClientField2=&ClientField3=&PayType=50&RakutenChargeID=ch_67XXXXXXX8M&ReauthLimitDate=&SalesLimitDate=&ChangeLimitDate=20210308125035&CancelLimitDate=20210308125035&RakutenPoint=&RakutenSubscriptionType=SETTLEMENT&RakutenSubscriptionID=&RakutenSettlementSubscriptionID=sub_XXXXXXXXXXX&RakutenSubscriptionCurrentStatus=&RakutenSubscriptionStartDate=&RakutenSubscriptionAmount=

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

楽天ペイ(オンライン決済)V2